pp108 : append (FTP)

append (FTP)


This Web service operation appends a source file to a specified target file.

SOAP Request
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <append xmlns="http://schemas.cordys.com/ftpconnector/1.1">
            <configuration>ftpserver</configuration>
            <synchronous>true</synchronous>
            <notification-subject>FTP</notification-subject>
            <files>
                <path type="ascii">
                    <source>\tempdocs\dev_readme.txt</source>
                    <target>/readme.txt</target>
                </path>
            </files>
        </append>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Tags

Description

configuration

Name of the Configuration Profile that contains the FTP server details.

synchronous

Specifies if the response must be intimated to the client. This can hold the following values:

  • true - The process will continue without any interruption and the FTP client would wait for the response.
  • false - The event handler will handle the response.

notification-subject

Notification subject on which the user has to subscribe to the Event service, to obtain the status of the request.

files

Contains the files to append.

path

The path of a file on the FTP server. The type attribute here specifies the type of file to append (ascii or binary).

  • If you want to specify the binary file type in the request, set the value as bin.
  • If you want to specify the ASCII file type in the request, set the value as ascii.

type

The mode of transfer either (ASCII or binary).

source

The source path of the file to append.

target

The target path to which the source file has to be appended.


SOAP Response
<appendResponse xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <configuration xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">ftpserver</configuration>
    <notification-subject
        xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">FTP</notification-subject>
    <files xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <path type="ascii"
            xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
            <source>\tempdocs\dev_readme.txt</source>
            <target>/readme.txt</target>
            <statuscode
                xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">226</statuscode>
            <status xmlns="http://schemas.cordys.com/ftpconnector/1.1" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">Transfer complete.</status>
        </path>
    </files>
</appendResponse>